Stappenplan API
1. Toegang API
Verkrijg inlog gegevens voor u organisatie.
2. Integratie API
Toepassen van API in verschillende (visuele) applicaties.
Om toegang te krijgen tot de data uit de database, is een Application Programming Interface (API) ontwikkeld. Deze API fungeert als een centrale schakel waarmee organisaties eenvoudig gegevens kunnen opvragen, zoals metingen van sensoren en andere project-specifieke informatie.
De API is ontworpen met flexibiliteit en gebruiksgemak in gedachten, zodat verschillende organisaties deze kunnen integreren in hun eigen systemen of workflows. Door middel van gestandaardiseerde verzoeken kunnen gebruikers real time data ophalen en verwerken.
Een API (Application Programming Interface) is eigenlijk een manier waarop verschillende softwareprogramma's met elkaar kunnen communiceren. Het is een soort "brug" die ervoor zorgt dat de ene applicatie de andere kan vragen om bepaalde gegevens of acties uit te voeren, zonder dat ze precies hoeven te weten hoe de ander werkt. Om toegang te krijgen tot de API en deze effectief te gebruiken, kunt u de volgende stappen volgen.
Stap 1. Toegang API
Om toegang tot de API te krijgen dient u bij de beheerder een organisatie specifieke inlog aan te vragen bestaande uit een:
• Gebruikersnaam
• Wachtwoord
Neem hiervoor contact op. De gebruikersnaam en het wachtwoord heeft u bij stap 2 nodig.
Stap 2. Integratie API
Om toegang tot de API te krijgen dient u de gebruikersnaam en het wachtwoord te gebruiken om een unieke code, die u als specifieke gebruiker identificeert te verkrijgen. Deze code kan op verschillende manieren verkregen worden, wij maken gebruik van het platform Swagger.
Stel je voor dat je een applicatie gebruikt die gegevens van een andere applicatie nodig heeft, bijvoorbeeld om het weer te bekijken of om informatie van een website op te halen. Swagger is een hulpmiddel die u wegwijs maakt in de API, zodat u als gebruiker weet hoe u de juiste informatie kunt opvragen van de andere applicatie.
Wat is Swagger?
1. Zorgt voor duidelijke uitleg
Swagger maakt een online handleiding voor de API, waarin staat wat je kan opvragen (bijvoorbeeld "Wat is de temperatuur in Amsterdam?") en hoe je dat moet doen.
2. Interactieve interface
Met Swagger kan je direct testen of de API goed werkt. Je kan bijvoorbeeld in een formulier invullen welke gegevens je wilt opvragen en meteen zien wat je terugkrijgt. Dit helpt u om zeker te weten dat de API goed functioneert zonder zelf technische kennis te hebben.
3. Snel vinden wat je nodig hebt
Swagger toont alle beschikbare functies en gegevens die je kan opvragen, zoals bijvoorbeeld een lijst van steden waarvan je het weer kan zien. Het maakt het makkelijker om te begrijpen welke informatie beschikbaar is en hoe je die kan krijgen.
De code die via Swagger verkregen wordt is een Bearer token, een soort digitale sleutel die je "mee stuurt" wanneer je een aanvraag doet naar een server of een API, zodat de server weet dat je gemachtigd bent om de gevraagde informatie te krijgen. Voor het verkrijgen van de token gaat u naar Sensorservice.nl.
Stap 3. Inloggen
Op sensorservice gaat u naar (rpc) login. Hier klikt u in de bovenhoek op Try it out. Vervolgens kan u bij username de verkregen gebruikersnaam uit stap 1 invullen en bij pass het wachtwoord, klik op Execute. Als beide gegevens correct zijn ingevuld ziet u Code 200 dit betekend dat de aanvraag goed is gegaan. Onder Response body ziet u de bearer token kopieer hierbij alles tussen de aanhalingstekens ("").
Stap 4. Bearer token toepassen
Nu heeft u de bearer token die benodigd is voor het opvragen van de API. Om in te zien welke gegevens op te vragen zijn gaat u in sensorservice.nl naar Authorize rechts boven in het beeld, hier vult u het volgende in Bearer bearer token.
Voorbeeld:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiO UzI1NiIs
Het is belangrijk dat het woord Bearer met hoofdletter word ingevuld en dat er een spatie tussen Bearer en uw bearer token zit. Zorg er voor dat er geen aanhalingstekens om u verkregen bearer token staan. Deze stap gebruikt u ook voor het toepassen van de API in andere applicaties.
Stap 5. Parameters inzien
Vervolgens ziet u de verschillende tabellen uit de database. Als u bij een van de tabellen, bijvoorbeeld projects het GET menu openklapt zijn alle kolommen van de betreffende tabel in te zien.
Stap 6. Parameters opvragen
In de Description kan u vervolgens gegevens opvragen van u project. Voorbeeld: u wilt de meetwaardes van sensor 11 weten, dan vult u bij sensor_id eq.11 in. Voor het id dient eq. ingevuld te worden dit is een afkorting van equal to. Bij limit vult u het bereik in anders gaat de API alle waardes van sensor 11 ophalen. In het voorbeeld is waarde 50 ofwel de laatste 50 meetwaardes toegepast. Vervolgens kan u in het veld Responses de gegevens inzien.
Een GET-verzoek wordt gebruikt om informatie op te halen van een server. Dit is als het ware een "vraag" die je aan de server stelt om bepaalde gegevens terug te krijgen. Een GET-commando verandert niets op de server; het is alleen bedoeld om data op te halen. zie voorbeelden.
Stap 7.
De onderstaande structuur kan gebruik worden voor makkelijke navigatie van de database. Nu ben je klaar om de API te gebruiken. Bij vragen verzoeken wij contact op te nemen.
Voorbeeld: ik wil de inhoud van tabel Projects zien :
GET /api/projects HOST: https://sensorservice.nl
Voorbeeld: ik wil de data zien van project Proef opstelling:
GET /api/projects?project_name=Proefopstelling HOST: https://sensorservice.nl
Voor het makkelijk navigeren van de API kunt u de structuur volgen.
